SCHED: GetTaskGroupReportOpts
Format
SCHED / GetTaskGroupReportOpts '<TaskGroupName>' '<FileName>' <OptionList>
Description
The SCHED GetTaskGroupReportOpts Connect command returns a detailed report of the task group/(s) specified by the <TaskGroupName> parameter, just like the GetTaskGroupReport command, but the report generated by this command only contains the elements of the Task Group Report that are requested in the "OptionsList".
Parameters
- TaskGroupName: The parameter is a string of text in single quotes of a comma delimited list of task groups. Task group names should not be in quotes and "ALL" may be used to return all task groups present in the schedule. Supports the use of wildcards.
- FileName: The parameter is a string of text in single quotes of the absolute path file name. Empty string is allowed if it is not written out to a file.
- OptionList: One or more strings specifying what fields should be in the report. There are several available; the strings should match the detail labels described in the Task Group Report Details page. If the OptionsList is empty, the full report is returned. Note that the options should not be enclosed by quotes.
Examples
Requests all Task Group reports for the active schedule to the fie "out.txt" located at "C:\Outputs\"
SCHED / GetTaskGroupReport 'ALL' 'C:\Outputs\out.txt' TG_TASKGROUP_NAME
TG_TASKGROUP_INCLUDED_TASKS
| Syntax | Example |
|---|---|
| <CommandName> | SCHED / GetTaskGroupReport |
| <TaskGroupName> | 'ALL' |
| <FileName> | 'C:\Outputs\out.txt' |
| <OptionsList> | TG_TASKGROUP_NAME TG_TASKGROUP_INCLUDED_TASKS |
Return Message
Connect returns a message that contains all of the report data for the task group(s). The report matches the format specified on the Task Group Report Details page.
Group Membership
This command belongs to the following group(s):
Version
10.1
